home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / SQLTEST.PY < prev    next >
Encoding:
Python Source  |  2000-05-30  |  9.4 KB  |  235 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85. '''Inserting optional tests with 'sqlgroup'
  86.   
  87.     It is sometimes useful to make inputs to an SQL statement
  88.     optinal.  Doing so can be difficult, because not only must the
  89.     test be inserted conditionally, but SQL boolean operators may or
  90.     may not need to be inserted depending on whether other, possibly
  91.     optional, comparisons have been done.  The 'sqlgroup' tag
  92.     automates the conditional insertion of boolean operators.  
  93.  
  94.     The 'sqlgroup' tag is a block tag that has no attributes. It can
  95.     have any number of 'and' and 'or' continuation tags.
  96.  
  97.     Suppose we want to find all people with a given first or nick name
  98.     and optionally constrain the search by city and minimum and
  99.     maximum age.  Suppose we want all inputs to be optional.  We can
  100.     use DTML source like the following::
  101.  
  102.       <dtml-sqlgroup>
  103.         <dtml-sqlgroup>
  104.           <dtml-sqltest name column=nick_name type=nb multiple optional>
  105.         <dtml-or>
  106.           <dtml-sqltest name column=first_name type=nb multiple optional>
  107.         </dtml-sqlgroup>
  108.       <dtml-and>
  109.         <dtml-sqltest home_town type=nb optional>
  110.       <dtml-and>
  111.         <dtml-if minimum_age>
  112.            age >= <dtml-sqlvar minimum_age type=int>
  113.         </dtml-if>
  114.       <dtml-and>
  115.         <dtml-if maximum_age>
  116.            age <= <dtml-sqlvar maximum_age type=int>
  117.         </dtml-if>
  118.       </dtml-sqlgroup>
  119.  
  120.     This example illustrates how groups can be nested to control
  121.     boolean evaluation order.  It also illustrates that the grouping
  122.     facility can also be used with other DTML tags like 'if' tags.
  123.  
  124.     The 'sqlgroup' tag checks to see if text to be inserted contains
  125.     other than whitespace characters.  If it does, then it is inserted
  126.     with the appropriate boolean operator, as indicated by use of an
  127.     'and' or 'or' tag, otherwise, no text is inserted.
  128.  
  129. '''
  130. __rcs_id__='$Id: sqltest.py,v 1.13 2000/05/30 15:46:55 brian Exp $'
  131.  
  132. ############################################################################
  133. #     Copyright 
  134. #
  135. #       Copyright 1996 Digital Creations, L.C., 910 Princess Anne
  136. #       Street, Suite 300, Fredericksburg, Virginia 22401 U.S.A. All
  137. #       rights reserved.
  138. #
  139. ############################################################################ 
  140. __version__='$Revision: 1.13 $'[11:-2]
  141.  
  142. import sys
  143. from DocumentTemplate.DT_Util import ParseError, parse_params, name_param
  144. str=__builtins__['str']
  145.  
  146. from string import find, split, join, atoi, atof
  147. from types import ListType, TupleType, StringType
  148.  
  149. class SQLTest: 
  150.     name='sqltest'
  151.     optional=multiple=None
  152.  
  153.     def __init__(self, args):
  154.         args = parse_params(args, name='', type=None, column=None,
  155.                             multiple=1, optional=1, op=None)
  156.         self.__name__ = name_param(args,'sqlvar')
  157.         has_key=args.has_key
  158.         if not has_key('type'):
  159.             raise ParseError, ('the type attribute is required', 'sqltest')
  160.         self.type=t=args['type']
  161.         if not valid_type(t):
  162.             raise ParseError, ('invalid type, %s' % t, 'sqltest')
  163.         if has_key('optional'): self.optional=args['optional']
  164.         if has_key('multiple'): self.multiple=args['multiple']
  165.         if has_key('column'): self.column=args['column']
  166.         else: self.column=self.__name__
  167.  
  168.         # Deal with optional operator specification
  169.         op = '='                        # Default
  170.         if has_key('op'):
  171.             op = args['op']
  172.             # Try to get it from the chart, otherwise use the one provided
  173.             op = comparison_operators.get(op, op)
  174.         self.op = op
  175.  
  176.     def render(self, md):
  177.         name=self.__name__
  178.         t=self.type
  179.         try: v = md[name]
  180.         except KeyError, key:
  181.             if str(key)==name and self.optional: return ''
  182.             raise KeyError, key, sys.exc_info()[2]
  183.             
  184.         
  185.         if type(v) in (ListType, TupleType):
  186.             if len(v) > 1 and not self.multiple:
  187.                 raise 'Multiple Values', (
  188.                     'multiple values are not allowed for <em>%s</em>'
  189.                     % name)
  190.         else: v=[v]
  191.         
  192.         vs=[]
  193.         for v in v:
  194.             if not v and type(v) is StringType and t != 'string': continue
  195.             if t=='int':
  196.                 try:
  197.                     if type(v) is StringType: atoi(v)
  198.                     else: v=str(int(v))
  199.                 except:
  200.                     raise ValueError, (
  201.                         'Invalid integer value for <em>%s</em>' % name)
  202.             elif t=='float':
  203.                 if not v and type(v) is StringType: continue
  204.                 try:
  205.                     if type(v) is StringType: atof(v)
  206.                     else: v=str(float(v))
  207.                 except:
  208.                     raise ValueError, (
  209.                         'Invalid floating-point value for <em>%s</em>' % name)
  210.             else:
  211.                 v=str(v)
  212.                 v=md.getitem('sql_quote__',0)(v)
  213.                 #if find(v,"\'") >= 0: v=join(split(v,"\'"),"''")
  214.                 #v="'%s'" % v
  215.     
  216.             vs.append(v)
  217.  
  218.         if not vs:
  219.             if self.optional: return ''
  220.             raise 'Missing Input', (
  221.                 'No input was provided for <em>%s</em>' % name)
  222.  
  223.         if len(vs) > 1:
  224.             vs=join(map(str,vs),', ')
  225.             return "%s in (%s)" % (self.column,vs)
  226.         return "%s %s %s" % (self.column, self.op, vs[0])
  227.  
  228.     __call__=render
  229.  
  230. valid_type={'int':1, 'float':1, 'string':1, 'nb': 1}.has_key
  231.  
  232. comparison_operators = { 'eq': '=', 'ne': '<>',
  233.                          'lt': '<', 'le': '<=', 'lte': '<=',
  234.                          'gt': '>', 'ge': '>=', 'gte': '>=' }
  235.